/*
 * Copyright 2002-2007 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package nl.jteam.jsa.core;

import java.util.Map;

/**
 * A factory to create {@link DocumentManager document managers}.
 *
 * @author Uri Boness
 */
public interface DocumentManagerFactory {

    /**
     * Creates and returns a new document manager.
     *
     * @return The newly created document manager.
     */
    DocumentManager createDocumentManager();

    /**
     * Creates and returns a new document manager based on the given properties.
     *
     * @param properties The properties based on which the document manager will be created.
     * @return The newly created document manager.
     */
    DocumentManager createDocumentManager(Map properties);

    /**
     * Returns a query factory with which one can create search queries to be processed by the document manager this
     * factory creates.
     *
     * @return The appropriate query factory.
     */
    QueryFactory getQueryFactory();

}
